Manage Order API
How to use the API
Here's an overview of the features included in this API, what they do and what you can use them for:
| API Feature | What it does | What it's used for |
|---|---|---|
| Get API Version | Retrieves the full version number of the API (major, minor and patch version numbers) | Viewing the API version. |
| Create order | Creates an order | Allows RSPs to submit an order request if confirmed as feasible via an Order Feasibility request. |
| Amend order | Amends an order | Allows RSPs to manage and amend an order, update order details, contact details, raise interactions or to escalate. |
| Cancel order | Cancels an order | Allows RSPs to cancel an order. |
| Get order details | Get order details | Retrieves order details, including status, site visits, charges, and other information relevant to the order. |
| Get order attachments | Get order attachments | Retrieves an attachment previously added to an order. |
| Get order notifications | Get order notifications | Retrieves any notifications associated with an order. |
orderCharges array
The following values are provided by the orderCharges array.
| Value | Description |
|---|---|
| category | Category of the charge. |
| productOfferName | Product offer name (for example: Business 1, Standard CSE). |
| chargeType | Type of charge for the category, for example: Recurring, One Time. |
| unitCost | Unit cost in dollars ($) for the category selected. Data type = decimal |
| quantity | Quantity of category selected based on unit cost. Data type =decimal |
| value | Total value in dollars ($) of the category selected. Data type =decimal |
notificationPreference
The following values are provided by the requestNotify attribute.
| Value | Description |
|---|---|
| true | Receive email notificaitons about the order. |
| false | Do not receive email notifications about the order. |
notificationEmail
The following values are provided by the notificationEmail attribute.
| Value | Description |
|---|---|
| notificationEmail | The email address to receive order notifications. |
locationDetails
The following location and equipment access information is provided by the locationDetails array.
| Name | Description |
|---|---|
| siteAccessInformation | Provides any specific site information in a free text field for the technician (for example: dog on site, rear building, check in at reception, specific sign in process at data centres, health and safety procedures and certificates required on site). Note: This field is restricted to 2000 characters. |
| locationOfEquipment | Guidance for the technician on where the equipment is to be installed on site (for example: install ONT to the wall in the garage). Note: This field is restricted to 2000 characters. |
retainCopper
The following values are provided by the retainCopper attribute.
| Value | Description |
|---|---|
| True | Copper is to be retained (for example: alarm monitoring or voice over copper). |
| False | Copper is not to be retained. |
contactDetails
The contactDetails array is used to add contact information for order contacts.
The following values are provided by the contactDetails array.
| Value | Description |
|---|---|
| contactName | Name of the primary contact on site. |
| contactType | Provides details of contact types and roles. The following contact types can be added: - Site Contact - primary contact on site and familiar with the order - Additional Contact - used if the order requires an additional contact person - Order Contact - administrative person for the order - IT Contact - IT contact person for the order - Legal Owner - the Legal Owner of the location - Body Corporate - Body Corporate contact person for the order - Property Manager - Property Manager contact person for the order. |
| preferredPhone | Preferred phone number for the primary site contact. |
| alternatePhone | Alternate phone number for any contact you have added to the order. |
| Email address for any contact you have added to the order. |
States and substates
Orders are managed using states and substates. As the order progresses and when scoping and installation work is carried out, the order state changes.
Note: All states apply to all orders.
The following state and substate values are provided.
| State value | Substate value | Description |
|---|---|---|
| Acknowledged | Received | The order has been received by Chorus. |
| Acknowledged | Accepted | The order has been checked and is accepted for provisioning. |
| In Progress | Consent Required | Consent is required before this order can be progressed. |
| In Progress | Consent Requested | Consent has been requested. |
| In Progress | Consent Not Required | Consent is not required for this order. |
| In Progress | Consent Gained | Consent has been given. |
| In Progress | Consent Declined | The consent request has been declined or was not obtained within the required timeframe. |
| In Progress | Generate Quotation | A quote is being generated for the order. |
| In Progress | Intent to Cancel | Chorus has advised the intent to cancel the order and provided a reason for the cancellation. |
| In Progress | Network Design | The network design is currently in progress. |
| In Progress | Network Build | The network build is currently in progress. |
| In Progress | Scoping Scheduled | Scoping for this order has been scheduled. |
| In Progress | Scheduled | The order install has been scheduled. |
| In Progress | Investigation Required | Identified as a potential multi dwelling unit (MDU) or right of way (ROW). Investigation is required. |
| Held | Waiting on Quote Acceptance | A quote has been created and is ready for your acceptance. |
| Held | Schedule Scoping | Scoping for this order is to be scheduled. |
| Held | Schedule Install | The required installation date needs to be scheduled. |
| Held | Intent to Cancel | Chorus has advised the intent to cancel the order and provided a reason for the cancellation. |
| Held | Provider to Advise | Provide information to Chorus so the order can progress. |
| Held | Pending Disconnect Acceptance | Review the order and either accept/reject our disconnection notification. |
| Service Given | Service Given | Installation work is complete. The end user can now use the service at their location. |
| Completed | Billing | Billing is complete. |
| Closed | Cancelled | The order has been cancelled and closed. |
| Closed | Completed | The order has been completed and closed. |
Site visit order types
With site visit
The following reference table summarises which attributes/arrays are required for order types with a site visit.
| With site visit | Connect Primary | Connect Additional ONT | Connect Secondary | Connect and Replace | Modify Attribute | Change Offer | Transfer Primary | Transfer Secondary | Move Primary | Move Additional; ONT | Disconnect Primary | Disconnect Secondary |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| connectRFSDateTime | No | No | No | No | No | No | No | No | No | No | No | NA |
| disconnectRFSDateTime | No | No | No | No | No | No | No | No | No | No | No | NA |
| productOfferDetails | Yes | Yes | Yes | Yes | C1 | C2 | Yes | Yes | Yes | Yes | No | NA |
| cseProductOfferDetails | Optional | Optional | Yes | Optional | Yes | Optional | Optional | Optional | Optional | Optional | Yes | NA |
| contactDetails | C5 | C5 | C5 | C5 | C5 | C5 | C5 | C5 | C5 | C5 | C5 | NA |
| locationDetails.siteAccessInformation | Optional | NA | Optional | Optional | Optional | Optional | Optional | Optional | Optional | NA | Optional | NA |
| locationDetails.LocationOfEquipment | C3 | C3 | C3 | C3 | C3 | C3 | C3 | C3 | C3 | C3 | C3 | NA |
| locationDetails.retainCopper | Optional | Optional | Optional | Optional | Optional | Optional | Optional | Optional | Optional | NA | Optional | NA |
| customerDetails.endCustomer | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | NA |
| customerDetails.providerReference | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | NA |
| customerDetails.notificationPreference | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | NA |
| customerDetails.notificationEmail | C4 | C4 | C4 | C4 | C4 | C4 | C4 | C4 | C4 | C4 | C4 | NA |
| billingDetails.billingAccount | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | NA |
Key:
- C1 - productOfferDetails is required if an RSP wants to modify the characteristics. This is optional if the intention is to order CSE product only.
- C2 - productOfferDetails is optional for change offer, if the old product offer and new product offer have same characteristics, and the RSP wants to use the same character value.
- C3 - locationDetails.LocationOfEquipment is required when the market segment is Business or Education.
- C4 - notificationEmail is required if notificationPreference is Notify.
- C5 – contactDetails – the site contact is always required when there is a site visit, and orderContact and itContact are always required when there is a site visit and the market segment is Business or Education.
Without site visit
The following reference table summarises which attributes/arrays are required for order types without a site visit.
| Without site visit | Connect Primary | Connect Additional ONT | Connect Secondary | Connect and Replace | Modify Attribute | Change Offer | Transfer Primary | Transfer Secondary | Move Primary | Move Additional; ONT | Disconnect Primary | Disconnect Secondary |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| connectRFSDateTime | Yes | NA | Yes | Yes | Yes | Yes | Yes | Yes | Yes | NA | No | No |
| disconnectRFSDateTime | No | NA | No | No | No | No | No | No | Yes | NA | Yes | Yes |
| productOfferDetails | Yes | NA | Yes | Yes | Yes | C2 | Yes | Yes | Yes | NA | No | No |
| cseProductOfferDetails | No | NA | No | Optional | No | No | No | No | No | NA | No | No |
| contactDetails | Optional | NA | Optional | Optional | Optional | Optional | Optional | Optional | Optional | NA | Optional | Optional |
| locationDetails.siteAccessInformation | Optional | NA | Optional | Optional | Optional | Optional | Optional | Optional | Optional | NA | Optional | Optional |
| locationDetails.LocationOfEquipment | C3 | NA | C3 | C3 | C3 | C3 | C3 | C3 | C3 | NA | C3 | C3 |
| locationDetails.retainCopper | Optional | NA | Optional | Optional | Optional | Optional | Optional | Optional | Optional | NA | Optional | Optional |
| customerDetails.endCustomer | Yes | NA | Yes | Yes | Yes | Yes | Yes | Yes | Yes | NA | Yes | Yes |
| customerDetails.providerReference | Yes | NA | Yes | Yes | Yes | Yes | Yes | Yes | Yes | NA | Yes | Yes |
| customerDetails.notificationPreference | Yes | NA | Yes | Yes | Yes | Yes | Yes | Yes | Yes | NA | Yes | Yes |
| customerDetails.notificationEmail | C4 | NA | C4 | C4 | C4 | C4 | C4 | C4 | C4 | NA | C4 | C4 |
| billingDetails.billingAccount | Yes | NA | Yes | Yes | Yes | Yes | Yes | Yes | Yes | NA | Yes | Yes |
Key:
- C2 - productOfferDetails is optional for change offer, if the old product offer and new product offer have same characteristics, and the RSP wants to use the same character value.
- C3 - locationDetails.LocationOfEquipment is required when the market segment is Business or Education.
- C4 - notificationEmail is required if notificationPreference is Notify.
Refer to the API Specification for more information on all available resources, attributes, parameters, field types, length, and other restrictions.